<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="null" lang="null">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" /><title>IdFunction xref</title>
<link type="text/css" rel="stylesheet" href="../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../apidocs/org/jaxen/function/IdFunction.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em class="comment">/*</em>
<a name="2" href="#2">2</a>   <em class="comment"> * $Header$</em>
<a name="3" href="#3">3</a>   <em class="comment"> * $Revision: 1128 $</em>
<a name="4" href="#4">4</a>   <em class="comment"> * $Date: 2006-02-05 13:49:04 -0800 (Sun, 05 Feb 2006) $</em>
<a name="5" href="#5">5</a>   <em class="comment"> *</em>
<a name="6" href="#6">6</a>   <em class="comment"> * ====================================================================</em>
<a name="7" href="#7">7</a>   <em class="comment"> *</em>
<a name="8" href="#8">8</a>   <em class="comment"> * Copyright 2000-2002 bob mcwhirter &amp; James Strachan.</em>
<a name="9" href="#9">9</a>   <em class="comment"> * All rights reserved.</em>
<a name="10" href="#10">10</a>  <em class="comment"> *</em>
<a name="11" href="#11">11</a>  <em class="comment"> * Redistribution and use in source and binary forms, with or without</em>
<a name="12" href="#12">12</a>  <em class="comment"> * modification, are permitted provided that the following conditions are</em>
<a name="13" href="#13">13</a>  <em class="comment"> * met:</em>
<a name="14" href="#14">14</a>  <em class="comment"> * </em>
<a name="15" href="#15">15</a>  <em class="comment"> *   * Redistributions of source code must retain the above copyright</em>
<a name="16" href="#16">16</a>  <em class="comment"> *     notice, this list of conditions and the following disclaimer.</em>
<a name="17" href="#17">17</a>  <em class="comment"> * </em>
<a name="18" href="#18">18</a>  <em class="comment"> *   * Redistributions in binary form must reproduce the above copyright</em>
<a name="19" href="#19">19</a>  <em class="comment"> *     notice, this list of conditions and the following disclaimer in the</em>
<a name="20" href="#20">20</a>  <em class="comment"> *     documentation and/or other materials provided with the distribution.</em>
<a name="21" href="#21">21</a>  <em class="comment"> * </em>
<a name="22" href="#22">22</a>  <em class="comment"> *   * Neither the name of the Jaxen Project nor the names of its</em>
<a name="23" href="#23">23</a>  <em class="comment"> *     contributors may be used to endorse or promote products derived </em>
<a name="24" href="#24">24</a>  <em class="comment"> *     from this software without specific prior written permission.</em>
<a name="25" href="#25">25</a>  <em class="comment"> * </em>
<a name="26" href="#26">26</a>  <em class="comment"> * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS</em>
<a name="27" href="#27">27</a>  <em class="comment"> * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED</em>
<a name="28" href="#28">28</a>  <em class="comment"> * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A</em>
<a name="29" href="#29">29</a>  <em class="comment"> * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER</em>
<a name="30" href="#30">30</a>  <em class="comment"> * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,</em>
<a name="31" href="#31">31</a>  <em class="comment"> * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,</em>
<a name="32" href="#32">32</a>  <em class="comment"> * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR</em>
<a name="33" href="#33">33</a>  <em class="comment"> * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF</em>
<a name="34" href="#34">34</a>  <em class="comment"> * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING</em>
<a name="35" href="#35">35</a>  <em class="comment"> * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS</em>
<a name="36" href="#36">36</a>  <em class="comment"> * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</em>
<a name="37" href="#37">37</a>  <em class="comment"> *</em>
<a name="38" href="#38">38</a>  <em class="comment"> * ====================================================================</em>
<a name="39" href="#39">39</a>  <em class="comment"> * This software consists of voluntary contributions made by many </em>
<a name="40" href="#40">40</a>  <em class="comment"> * individuals on behalf of the Jaxen Project and was originally </em>
<a name="41" href="#41">41</a>  <em class="comment"> * created by bob mcwhirter &lt;bob@werken.com> and </em>
<a name="42" href="#42">42</a>  <em class="comment"> * James Strachan &lt;jstrachan@apache.org>.  For more information on the </em>
<a name="43" href="#43">43</a>  <em class="comment"> * Jaxen Project, please see &lt;<a href="http://www.jaxen.org/" target="alexandria_uri">http://www.jaxen.org/</a>>.</em>
<a name="44" href="#44">44</a>  <em class="comment"> * </em>
<a name="45" href="#45">45</a>  <em class="comment"> * $Id: IdFunction.java 1128 2006-02-05 21:49:04Z elharo $</em>
<a name="46" href="#46">46</a>  <em class="comment"> */</em>
<a name="47" href="#47">47</a>  
<a name="48" href="#48">48</a>  <strong>package</strong> org.jaxen.function;
<a name="49" href="#49">49</a>  
<a name="50" href="#50">50</a>  <strong>import</strong> java.util.ArrayList;
<a name="51" href="#51">51</a>  <strong>import</strong> java.util.Collections;
<a name="52" href="#52">52</a>  <strong>import</strong> java.util.Iterator;
<a name="53" href="#53">53</a>  <strong>import</strong> java.util.List;
<a name="54" href="#54">54</a>  <strong>import</strong> java.util.StringTokenizer;
<a name="55" href="#55">55</a>  
<a name="56" href="#56">56</a>  <strong>import</strong> org.jaxen.Context;
<a name="57" href="#57">57</a>  <strong>import</strong> org.jaxen.Function;
<a name="58" href="#58">58</a>  <strong>import</strong> org.jaxen.FunctionCallException;
<a name="59" href="#59">59</a>  <strong>import</strong> org.jaxen.Navigator;
<a name="60" href="#60">60</a>  
<a name="61" href="#61">61</a>  <em>/**</em>
<a name="62" href="#62">62</a>  <em> * &lt;p>&lt;b>4.1&lt;/b> &lt;code>&lt;i>node-set&lt;/i> id(&lt;i>object&lt;/i>)&lt;/code> &lt;/p></em>
<a name="63" href="#63">63</a>  <em> *  </em>
<a name="64" href="#64">64</a>  <em> * &lt;p>The &lt;b>id&lt;/b> function returns a &lt;code>List&lt;/code></em>
<a name="65" href="#65">65</a>  <em> * of all the elements in the context document that have an ID</em>
<a name="66" href="#66">66</a>  <em> * matching one of a specified list of IDs. How an attribute is determined</em>
<a name="67" href="#67">67</a>  <em> * to be of type ID depends on the navigator, but it normally requires that</em>
<a name="68" href="#68">68</a>  <em> * the attribute be declared to have type ID in the DTD. </em>
<a name="69" href="#69">69</a>  <em> * &lt;/p></em>
<a name="70" href="#70">70</a>  <em> * </em>
<a name="71" href="#71">71</a>  <em> * &lt;p></em>
<a name="72" href="#72">72</a>  <em> * There should be no more than one element in any document with a </em>
<a name="73" href="#73">73</a>  <em> * certain ID. However, if there are multiple such elements--i.e. if </em>
<a name="74" href="#74">74</a>  <em> * there are duplicate IDs--then this function selects only the first element </em>
<a name="75" href="#75">75</a>  <em> * in document order with the specified ID. </em>
<a name="76" href="#76">76</a>  <em> * &lt;/p></em>
<a name="77" href="#77">77</a>  <em> * </em>
<a name="78" href="#78">78</a>  <em> * @author Erwin Bolwidt (ejb @ klomp.org)</em>
<a name="79" href="#79">79</a>  <em> * @author J\u00e9r\u00f4me N\u00e8gre (jerome.negre @ e-xmlmedia.fr)</em>
<a name="80" href="#80">80</a>  <em> * </em>
<a name="81" href="#81">81</a>  <em> * @see &lt;a href="<a href="http://www.w3.org/TR/xpath" target="alexandria_uri">http://www.w3.org/TR/xpath</a>#function-id" target="_top">Section 4.1 of the XPath Specification&lt;/a></em>
<a name="82" href="#82">82</a>  <em> */</em>
<a name="83" href="#83">83</a>  <strong>public</strong> <strong>class</strong> <a href="../../../org/jaxen/function/IdFunction.html">IdFunction</a> implements <a href="../../../org/jaxen/Function.html">Function</a>
<a name="84" href="#84">84</a>  {
<a name="85" href="#85">85</a>  
<a name="86" href="#86">86</a>      <em>/**</em>
<a name="87" href="#87">87</a>  <em>     * Create a new &lt;code>IdFunction&lt;/code> object.</em>
<a name="88" href="#88">88</a>  <em>     */</em>
<a name="89" href="#89">89</a>      <strong>public</strong> <a href="../../../org/jaxen/function/IdFunction.html">IdFunction</a>() {}
<a name="90" href="#90">90</a>      
<a name="91" href="#91">91</a>      <em>/**</em><em> </em>
<a name="92" href="#92">92</a>  <em>     * Returns a list of the nodes with the specified IDs.</em>
<a name="93" href="#93">93</a>  <em>     *</em>
<a name="94" href="#94">94</a>  <em>     * @param context the context at the point in the</em>
<a name="95" href="#95">95</a>  <em>     *         expression when the function is called</em>
<a name="96" href="#96">96</a>  <em>     * @param args a list with exactly one item which is either a string</em>
<a name="97" href="#97">97</a>  <em>     *     a node-set</em>
<a name="98" href="#98">98</a>  <em>     * </em>
<a name="99" href="#99">99</a>  <em>     * @return a &lt;code>List&lt;/code> containing the first node in document </em>
<a name="100" href="#100">100</a> <em>     *     with each of the specified IDs; or </em>
<a name="101" href="#101">101</a> <em>     *     an empty list if there are no such nodes</em>
<a name="102" href="#102">102</a> <em>     * </em>
<a name="103" href="#103">103</a> <em>     * @throws FunctionCallException if &lt;code>args&lt;/code> has more or less than one item</em>
<a name="104" href="#104">104</a> <em>     */</em>
<a name="105" href="#105">105</a>     <strong>public</strong> Object call(<a href="../../../org/jaxen/Context.html">Context</a> context, List args) throws FunctionCallException
<a name="106" href="#106">106</a>     {
<a name="107" href="#107">107</a>         <strong>if</strong> ( args.size() == 1 ) {
<a name="108" href="#108">108</a>             <strong>return</strong> evaluate( context.getNodeSet(),
<a name="109" href="#109">109</a>                              args.get(0), context.getNavigator() );
<a name="110" href="#110">110</a>         }
<a name="111" href="#111">111</a> 
<a name="112" href="#112">112</a>         <strong>throw</strong> <strong>new</strong> <a href="../../../org/jaxen/FunctionCallException.html">FunctionCallException</a>( <span class="string">"id() requires one argument"</span> );
<a name="113" href="#113">113</a>     }
<a name="114" href="#114">114</a> 
<a name="115" href="#115">115</a>     <em>/**</em><em> </em>
<a name="116" href="#116">116</a> <em>     * Returns a list of the nodes with the specified IDs.</em>
<a name="117" href="#117">117</a> <em>     * </em>
<a name="118" href="#118">118</a> <em>     * @param contextNodes the context node-set. The first item in this list</em>
<a name="119" href="#119">119</a> <em>     *     determines the document in which the search is performed.</em>
<a name="120" href="#120">120</a> <em>     * @param arg the ID or IDs to search for</em>
<a name="121" href="#121">121</a> <em>     * @param nav the navigator used to calculate string-values and search</em>
<a name="122" href="#122">122</a> <em>     *     by ID</em>
<a name="123" href="#123">123</a> <em>     * </em>
<a name="124" href="#124">124</a> <em>     * @return a &lt;code>List&lt;/code> containing the first node in document </em>
<a name="125" href="#125">125</a> <em>     *     with each of the specified IDs; or </em>
<a name="126" href="#126">126</a> <em>     *     an empty list if there are no such nodes</em>
<a name="127" href="#127">127</a> <em>     * </em>
<a name="128" href="#128">128</a> <em>     */</em>
<a name="129" href="#129">129</a>     <strong>public</strong> <strong>static</strong> List evaluate(List contextNodes, Object arg, <a href="../../../org/jaxen/Navigator.html">Navigator</a> nav)
<a name="130" href="#130">130</a>     {
<a name="131" href="#131">131</a>         <strong>if</strong> (contextNodes.size() == 0) <strong>return</strong> Collections.EMPTY_LIST;
<a name="132" href="#132">132</a>       
<a name="133" href="#133">133</a>         List nodes = <strong>new</strong> ArrayList();
<a name="134" href="#134">134</a> 
<a name="135" href="#135">135</a>         Object contextNode = contextNodes.get(0);
<a name="136" href="#136">136</a> 
<a name="137" href="#137">137</a>         <strong>if</strong> (arg instanceof List) {
<a name="138" href="#138">138</a>             Iterator iter = ((List)arg).iterator();
<a name="139" href="#139">139</a>             <strong>while</strong> (iter.hasNext()) {
<a name="140" href="#140">140</a>                 String id = StringFunction.evaluate(iter.next(), nav);
<a name="141" href="#141">141</a>                 nodes.addAll( evaluate( contextNodes, id, nav ) );
<a name="142" href="#142">142</a>             }
<a name="143" href="#143">143</a>         } 
<a name="144" href="#144">144</a>         <strong>else</strong> {
<a name="145" href="#145">145</a>             String ids = StringFunction.evaluate(arg, nav);
<a name="146" href="#146">146</a>             StringTokenizer tok = <strong>new</strong> StringTokenizer(ids, <span class="string">" \t\n\r"</span>);
<a name="147" href="#147">147</a>             <strong>while</strong> (tok.hasMoreTokens()) {
<a name="148" href="#148">148</a>                 String id = tok.nextToken();
<a name="149" href="#149">149</a>                 Object node = nav.getElementById(contextNode, id);
<a name="150" href="#150">150</a>                 <strong>if</strong> (node != <strong>null</strong>) {
<a name="151" href="#151">151</a>                     nodes.add(node);
<a name="152" href="#152">152</a>                 }
<a name="153" href="#153">153</a>             }
<a name="154" href="#154">154</a>         }
<a name="155" href="#155">155</a>         <strong>return</strong> nodes;
<a name="156" href="#156">156</a>     }
<a name="157" href="#157">157</a>     
<a name="158" href="#158">158</a> }
<a name="159" href="#159">159</a> 
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

